Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add 'deprecated' field for depreacted section generation in image docs #286

Merged
merged 27 commits into from
Nov 20, 2024

Conversation

linostar
Copy link
Contributor

Ping the @canonical/rocks team.


Description

The documentation generator for rocks is missing some parts necessary to generate the Deprecated channels & tags section.

This PR provides the necessary values so that the generator can identify the deperacted tags and list them accordingly, using the expired end-of-life value of each track to determine whether it is depreacted or not.

Related issues

OCI-Factory builds won't work if one image's track has an expired EOL value. Another PR to fix that issue will be out soon.

@linostar linostar requested a review from a team as a code owner November 13, 2024 12:37
src/docs/generate_oci_doc_yaml.py Outdated Show resolved Hide resolved
@linostar linostar force-pushed the ROCKS-1224/feat/support-deprecated-channels branch from 02ae05f to 1594b0a Compare November 15, 2024 08:20
@linostar
Copy link
Contributor Author

@clay-lake @zhijie-yang This is ready for review.

The result can be seen on Dockerhub's mock-rock page, where track 1.0-22.04 appears in the deprecated section because its EOL is 2024-05-01.

@zhijie-yang
Copy link
Contributor

image
image
Screenshots for the documentation on DockerHub.

Copy link
Contributor

@zhijie-yang zhijie-yang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thanks! @clay-lake wdyt?

Copy link
Contributor

@clay-lake clay-lake left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nit, but LGTM otherwise! Thanks.

src/image/release.py Outdated Show resolved Hide resolved
@linostar linostar merged commit 5ea3947 into main Nov 20, 2024
@cjdcordeiro cjdcordeiro deleted the ROCKS-1224/feat/support-deprecated-channels branch December 3, 2024 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants